cs-security-experience-api-services icon

cs-security-experience-api-services

2.4.x
(0 reviews)

📘 Documentación de la API - Servicio de Seguridad de Experiencia

Esta sección describe los atributos y uso del Servicio API Experience Security.

💂️ Información Base

  • Título de la API: Servicio API Experience Security
  • Versión: v2
  • URL Base: https://security-experience-api-{env}.us-e1.cloudhub.io/api/Reemplaza {env} con:
    • dev (Desarrollo)
    • qa (Aseguramiento de Calidad)
    • prod (Producción)

🔑 Autenticación

Encabezados Requeridos

EncabezadoTipoDescripción
AuthorizationStringToken Bearer en el formato Bearer {{API_KEY}}
client_idStringIdentificador único para clientes de API
  • Authorization
    • Longitud: 36 - 37 caracteres
    • Ejemplo: Bearer abcdefghijklmnopqrstuvwxyz1234567890
  • client_id
    • Longitud: 32 - 36 caracteres
    • Ejemplo: 123e4567-e89b-12d3-a456-426614174000

📌 Estos encabezados son requeridos en todas las solicitudes.

✨ Endpoint: Validar Identidad

POST /customer/v1/identity/validate

  • Descripción: Valida los datos de identificación de una persona.

Cuerpo de Solicitud

{
  "idUsuarioEntidad": "string (Base64, opcional)",
  "paramProducto": "string (requerido)",
  "producto": "string (requerido, ej., '010')",
  "canal": "string (requerido, ej., 'Fijo 001')",
  "datosValidacion": {
    "identificacion": {
      "Numero": "string (requerido)",
      "Tipo": "string (requerido, ej., '1' o '4')"
    },
    "primerApellido": "string (máx 16, requerido)",
    "nombres": "string (máx 40, requerido)",
    "fechaExpedicion/timestamp": "string (timestamp, requerido)"
  }
}

Cuerpo de Respuesta

Retorna un objeto RespValidacion con resultados detallados de validación.

🔒 Endpoint: Inicializar OTP

POST /security/v1/OTP/initialize

  • Descripción: Inicia una transacción OTP para verificación de identidad.

Cuerpo de Solicitud

{
  "idUsuarioEntidad": "string (opcional)",
  "iniciarTransaccionOTPSolicitud": {
    "codParametrizacion": "string (requerido)",
    "Identificacion": {
      "numero": "string (requerido)",
      "tipo": "string (requerido)"
    },
    "datosCuestionario": {
      "regValidacion": "string (requerido)",
      "procesoEvidente": "string (requerido)"
    }
  }
}

Cuerpo de Respuesta

Retorna un objeto IniciarTransaccionOTPRespuesta con detalles de la transacción.

🔐 Endpoint: Validar Código OTP

POST /security/v1/OTP/validate

  • Descripción: Valida el código OTP para una transacción activa.

Cuerpo de Solicitud

{
  "idUsuarioEntidad": "string (opcional)",
  "verificarCodigoOTPSolicitud": {
    "idTransaccionOTP": "UUID (requerido)",
    "codigoOTP": "string (6 dígitos o '000000') (requerido)"
  }
}

Cuerpo de Respuesta

{
  "resultadoVerificacionOTP": true,
  "mensaje": "string (opcional)"
}

📝 Otros Endpoints

EndpointDescripción
POST /security/v1/survey/generateGenera un cuestionario de seguridad.
POST /security/v1/survey/validateValida la encuesta completada.
POST /security/v1/portal/generate_tokenGenera un token de portal para PQRs.
POST /security/v1/portal/validate_tokenValida un token de portal para PQRs.
POST /security/v1/check_blsVerifica solicitante contra listas de bloqueo.

📎 Consulta los archivos de ejemplo asociados para esquemas detallados:
- v1/examples/request/
- v1/examples/response/

📊 Parámetros Comunes

ParámetroTipoDescripciónRequerido
client_idStringIdentificador del cliente de API✅
AuthorizationStringToken Bearer para autenticación✅

🔐 Esquemas de Seguridad

Aplicación de Client ID

CampoTipoRequeridoLongitudRegex
client_idStringSí32 - 36[a-zA-Z0-9]
client_secretStringSí32 - 64[a-zA-Z0-9]

OAuth 2.0

CampoTipoRequeridoLongitudRegex
AuthorizationStringSí36 - 37[a-zA-Z0-9-_.]

⚠️ Códigos de Error

CódigoDescripciónSolución Sugerida
400Solicitud IncorrectaRevisar sintaxis de solicitud y parámetros
401No AutorizadoValidar credenciales de autenticación
404No EncontradoConfirmar la URL del endpoint
500Error Interno del ServidorReintentar o contactar soporte técnico

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

  • Documentación actualizada por última vez: Septiembre 2025
  • Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services

Reviews